Allow to configure Netty http compression#4056
Closed
ArtyomGabeev wants to merge 1 commit intosoftwaremill:masterfrom
Closed
Allow to configure Netty http compression#4056ArtyomGabeev wants to merge 1 commit intosoftwaremill:masterfrom
ArtyomGabeev wants to merge 1 commit intosoftwaremill:masterfrom
Conversation
Contributor
Author
|
Manually checked with ZIO netty server, compression works fine with ZIOStream's. |
Member
|
Thanks! |
Contributor
Author
|
Ill check the LoggingHandler, but so far it works fine for me. |
Member
|
Maybe in You can see an example on how to add a custom test e.g. here: https://github.com/softwaremill/tapir/blob/master/server/netty-server/sync/src/test/scala/sttp/tapir/server/netty/sync/NettySyncServerTest.scala#L45 |
Leammas
reviewed
Nov 23, 2024
| def defaultInitPipeline(cfg: NettyConfig)(pipeline: ChannelPipeline, handler: ChannelHandler): Unit = { | ||
| cfg.sslContext.foreach(s => pipeline.addLast(s.newHandler(pipeline.channel().alloc()))) | ||
| pipeline.addLast(ServerCodecHandlerName, new HttpServerCodec()) | ||
| if (cfg.compressionEnabled) pipeline.addLast(new HttpContentCompressor(cfg.compressionContentSizeThreshold, Seq.empty: _*)) |
There was a problem hiding this comment.
This way it was failing for me in Runtime for netty 4.1.112 and Tapir 1.10.15
[info] 2024-11-23 21:07:49.260 WARN io.netty.channel.ChannelInitializer - Failed to initialize a channel. Closing: [id: 0xf0ede386, L:/127.0.0.1:9000 - R:/127.0.0.1:59802]
[info] java.lang.ClassCastException: class [Ljava.lang.Object; cannot be cast to class [Lio.netty.handler.codec.compression.CompressionOptions; ([Ljava.lang.Object; is in module java.base of loader 'bootstrap'; [Lio.netty.handler.codec.compression.CompressionOptions; is in unnamed module of loader 'app')
[info] at server.HttpServer$.pipeline$1(HttpServer.scala:42)
[info] at server.HttpServer$.$anonfun$run$4(HttpServer.scala:50)
[info] at server.HttpServer$.$anonfun$run$4$adapted(HttpServer.scala:50)
[info] at sttp.tapir.server.netty.internal.NettyBootstrap$$anon$1.initChannel(NettyBootstrap.scala:26)
[info] at io.netty.channel.ChannelInitializer.initChannel(ChannelInitializer.java:129)
[info] at io.netty.channel.ChannelInitializer.handlerAdded(ChannelInitializer.java:112)
[info] at io.netty.channel.AbstractChannelHandlerContext.callHandlerAdded(AbstractChannelHandlerContext.java:1130)
[info] at io.netty.channel.DefaultChannelPipeline.callHandlerAdded0(DefaultChannelPipeline.java:608)
[info] at io.netty.channel.DefaultChannelPipeline.access$100(DefaultChannelPipeline.java:45)
[info] at io.netty.channel.DefaultChannelPipeline$PendingHandlerAddedTask.execute(DefaultChannelPipeline.java:1460)
[info] at io.netty.channel.DefaultChannelPipeline.callHandlerAddedForAllHandlers(DefaultChannelPipeline.java:1114)
[info] at io.netty.channel.DefaultChannelPipeline.invokeHandlerAddedIfNeeded(DefaultChannelPipeline.java:649)
[info] at io.netty.channel.AbstractChannel$AbstractUnsafe.register0(AbstractChannel.java:513)
[info] at io.netty.channel.AbstractChannel$AbstractUnsafe.access$200(AbstractChannel.java:428)
[info] at io.netty.channel.AbstractChannel$AbstractUnsafe$1.run(AbstractChannel.java:485)
[info] at io.netty.util.concurrent.AbstractEventExecutor.runTask(AbstractEventExecutor.java:173)
[info] at io.netty.util.concurrent.AbstractEventExecutor.safeExecute(AbstractEventExecutor.java:166)
[info] at io.netty.util.concurrent.SingleThreadEventExecutor.runAllTasks(SingleThreadEventExecutor.java:469)
[info] at io.netty.channel.epoll.EpollEventLoop.run(EpollEventLoop.java:408)
[info] at io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:994)
[info] at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
[info] at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
[info] at java.base/java.lang.Thread.run(Thread.java:1575)
The following code works
new HttpContentCompressor(config.compressionThreshold, List.empty[CompressionOptions]: _*)
adamw
pushed a commit
that referenced
this pull request
Jan 8, 2026
I adapted #4056 to current version of code and added tests that verify that compression indeed works. Fixes: #2878 --------- Co-authored-by: Artyom Gabeev <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #2878
I'm unsure if I need to add tests since Netty provides the HttpContentCompressor.
Another question: I do not know about HttpStreamsServerHandler from Play Framework. Is it used for chunked HTTP responses?
HTTP compression should work with chunked responses by compressing each chunk. I need to check if the order of handlers is correct.
Thanks,
Artyom